home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xt / XtGetSelectionValueIncremental.z / XtGetSelectionValueIncremental
Encoding:
Text File  |  1998-10-30  |  6.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXttttGGGGeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnnVVVVaaaalllluuuueeeeIIIInnnnccccrrrreeeemmmmeeeennnnttttaaaallll((((3333XXXXtttt))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXttttGGGGeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnnVVVVaaaalllluuuueeeeIIIInnnnccccrrrreeeemmmmeeeennnnttttaaaallll((((3333XXXXtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XtGetSelectionValueIncremental,
  10.           XtGetSelectionValuesIncremental - obtain selection values
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           void XtGetSelectionValueIncremental(_w, _s_e_l_e_c_t_i_o_n, _t_a_r_g_e_t,
  14.           _c_a_l_l_b_a_c_k, _c_l_i_e_n_t__d_a_t_a, _t_i_m_e)
  15.                 Widget _w;
  16.                 Atom _s_e_l_e_c_t_i_o_n;
  17.                 Atom _t_a_r_g_e_t;
  18.                 XtSelectionCallbackProc _c_a_l_l_b_a_c_k;
  19.                 XtPointer _c_l_i_e_n_t__d_a_t_a;
  20.                 Time _t_i_m_e;
  21.  
  22.           void XtGetSelectionValuesIncremental(_w, _s_e_l_e_c_t_i_o_n, _t_a_r_g_e_t_s,
  23.           _c_o_u_n_t, _c_a_l_l_b_a_c_k, _c_l_i_e_n_t__d_a_t_a, _t_i_m_e)
  24.                 Widget _w;
  25.                 Atom _s_e_l_e_c_t_i_o_n;
  26.                 Atom *_t_a_r_g_e_t_s;
  27.                 int _c_o_u_n_t;
  28.                 XtSelectionCallbackProc _c_a_l_l_b_a_c_k;
  29.                 XtPointer _c_l_i_e_n_t__d_a_t_a;
  30.                 Time _t_i_m_e;
  31.  
  32.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  33.           _c_a_l_l_b_a_c_k  Specifies the callback procedure that is to be
  34.                     called when the selection value has been obtained.
  35.  
  36.           _c_l_i_e_n_t__d_a_t_a
  37.                     Specifies the argument that is to be passed to the
  38.                     specified procedure when it is called.
  39.  
  40.           _c_l_i_e_n_t__d_a_t_a
  41.                     Specifies the client data (one for each target
  42.                     type) that is passed to the callback procedure
  43.                     when it is called for that target.
  44.  
  45.           _c_o_u_n_t     Specifies the length of the targets and
  46.                     client_data lists.
  47.  
  48.           _s_e_l_e_c_t_i_o_n Specifies the particular selection desired (that
  49.                     is, primary or secondary).
  50.  
  51.           _t_a_r_g_e_t    Specifies the type of the information that is
  52.                     needed about the selection.
  53.  
  54.           _t_a_r_g_e_t_s   Specifies the types of information that is needed
  55.                     about the selection.
  56.  
  57.           _t_i_m_e      Specifies the timestamp that indicates when the
  58.                     selection value is desired.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXttttGGGGeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnnVVVVaaaalllluuuueeeeIIIInnnnccccrrrreeeemmmmeeeennnnttttaaaallll((((3333XXXXtttt))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXttttGGGGeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnnVVVVaaaalllluuuueeeeIIIInnnnccccrrrreeeemmmmeeeennnnttttaaaallll((((3333XXXXtttt))))
  71.  
  72.  
  73.  
  74.           _w         Specifies the widget that is making the request.
  75.  
  76.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  77.           The _X_t_G_e_t_S_e_l_e_c_t_i_o_n_V_a_l_u_e_I_n_c_r_e_m_e_n_t_a_l function is similar to
  78.           _X_t_G_e_t_S_e_l_e_c_t_i_o_n_V_a_l_u_e except that the _s_e_l_e_c_t_i_o_n__c_a_l_l_b_a_c_k
  79.           procedure will be called repeatedly upon delivery of
  80.           multiple segments of the selection value.  The end of the
  81.           selection value is indicated when _s_e_l_e_c_t_i_o_n__c_a_l_l_b_a_c_k is
  82.           called with a non-NULL value of length zero, which must
  83.           still be freed by the client. If the transfer of the
  84.           selection is aborted in the middle of a transfer (for
  85.           example, because to timeout), the _s_e_l_e_c_t_i_o_n__c_a_l_l_b_a_c_k
  86.           procedure is called with a type value equal to the symbolic
  87.           constant _X_T__C_O_N_V_E_R_T__F_A_I_L so that the requestor can dispose
  88.           of the partial selection value it has collected up until
  89.           that point. Upon receiving _X_T__C_O_N_V_E_R_T__F_A_I_L, the requesting
  90.           client must determine for itself whether or not a partially
  91.           completed transfer is meaningful.
  92.  
  93.           The _X_t_G_e_t_S_e_l_e_c_t_i_o_n_V_a_l_u_e_s_I_n_c_r_e_m_e_n_t_a_l function is similar to
  94.           _X_t_G_e_t_S_e_l_e_c_t_i_o_n_V_a_l_u_e_I_n_c_r_e_m_e_n_t_a_l except that it takes a list
  95.           of target types and a list of client data and obtains the
  96.           current value of the selection converted to each of the
  97.           targets.  The effect is as if each target were specified in
  98.           a separate call to _X_t_G_e_t_S_e_l_e_c_t_i_o_n_V_a_l_u_e_I_n_c_r_e_m_e_n_t_a_l.  The
  99.           callback is called once with the corresponding client data
  100.           for each target.  _X_t_G_e_t_S_e_l_e_c_t_i_o_n_V_a_l_u_e_s_I_n_c_r_e_m_e_n_t_a_l does
  101.           guarantee that all the conversions will use the same
  102.           selection value becaues the ownership of the selection
  103.           cannot change in the middle of the list, as would be when
  104.           calling _X_t_G_e_t_S_e_l_e_c_t_i_o_n_V_a_l_u_e_I_n_c_r_e_m_e_n_t_a_l repeatedly.
  105.  
  106.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  107.           _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s - _C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e
  108.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.